home *** CD-ROM | disk | FTP | other *** search
/ Mac Installer 3 / Mac Installer Volume 3 (1996).iso / mac / CavePlot / CP-GenRef / CP-GenRef.rsrc / CPTX_193_CavePlot-Text < prev    next >
Encoding:
Text File  |  1996-10-15  |  7.0 KB  |  163 lines

  1. CavePlot-Text File Format
  2.      Besides CavePlot's standard binary data format, CavePlot can also Load (import) and Save (export) ASCII TEXT files.   To load a TEXT file as survey data, and have it load properly, the text must be in a specified format.   There are a numerous possible ways to store survey data as a text file.   The format I have chosen, and named "CavePlot-Text" is given in the following “Rules”:  
  3.  
  4. General Rules for CavePlot-Text
  5. -Any line starting with Equals (=) is a command
  6. -Any line starting with an Apostrophe (‘) is ignored
  7. -Any line starting with alpha-numeric is a station name
  8. -Any line starting with whitespace contains survey data
  9. -Whitespace is one or more character with ASCII < 33
  10. -Names and data are both separated by white space
  11. -Any line starting with an asterisk (*) is a survey break
  12. -A station name always follows (next line) a survey break
  13. -LRCF data, if any, follows the station name
  14. -Command lines (for now) occupy only a single line each
  15. -Data is ordered: Dist Azim Incl (unless changed with =O=)
  16. -LRCF data is ordered: L R C F (unless changed with =O=)
  17. -Any command not recognized becomes a comment
  18. -Recognized commands currently include:
  19.    =N=   Precedes the name of the survey
  20.    =U=   Precedes the name of the distance units
  21.    =I=    Precedes general information (Several Ok)
  22.    =C=   Precedes a comment
  23.    =S1= Precedes a New Section Name
  24.    =S2=   ...(1,2,or3 is Sect Set#)
  25.    =S3=   ...As Above...
  26.    =S$= Specifies Section Num%, Status%, Color%, Name$
  27.    =SS= Specifies Color and Status for Sections (obsolete)
  28.    =O=   Precedes Data Order for the following survey
  29.    =D=   Precedes the Magnetic Declination Value
  30.    =P=   Precedes a Pattern% (SICN) for following stations
  31.    =A=  Precedes a Station's Attribute$
  32.    =A$= Precedes an Attribute Char$, Flag$, Name$
  33.    =F=   Signals the end of the survey data
  34.  
  35. Sample CavePlot-Text Listing
  36.      The following is a sample CavePlot-TEXT listing of the sample survey “Made Up Cave”.   This smaple listing shows what the format looks like, and demonstates the use of the simple and most common commands.   This is the same data as that listed in the Quick Tour section of this help file.
  37.  
  38. '  This line is ignored since it starts with a ' Character.
  39. '  This is a sample survey listing
  40. '  in CavePlot-Text format
  41. =N=This is a Fake Cave
  42. =U=Meters
  43. =I=Fake survey data for practice using CavePlot.
  44. A
  45.      10     30    -45
  46. A1     1     1     3         0
  47.      15.5     67    -10
  48. A2     3     0     2         2
  49.      23     33    -15
  50. A3     2     40     10     2
  51.      57     95    -5
  52. B1     10     15     10     2
  53. =C=The BIG ROOM
  54.      15     130     30
  55. B2     1     1     0          2
  56.      10     105    -5
  57. B3     1       0     0          1
  58. =C=The Bitter End of a Fake Cave
  59. =F=
  60.  
  61. More CavePlot-Text Info
  62.      Additions to this format in the future are likely.   Additions will come in the form of additional "Commands".   For this reason, unrecognized commands are stored in the station comments.
  63.      Besides my CavePlot-Text File format, CavePlot will also import and export survey data to and from some other text formats.   These formats currently include the Karst.SUR and Compass.DAT formats.   For more information on these other formats, see the documentation accompanying their parent programs, Karst and Compass, both of which are DOS programs.
  64.  
  65. Detailed Explanation of Commands
  66. =N=   Precedes the name of the survey
  67.      The rest of the line is put into the survey name.
  68.      Only the first 31 characters are used
  69.      Example  =N=This is a Fake Cave
  70.  
  71. =U=   Precedes the name of the Distance Units
  72.      The rest of the line is put into the Distance Units.
  73.      Only the first 15 characters are used
  74.      Example  =U=Meters
  75.  
  76. =I=   Precedes general information
  77.      The rest of the line is put into General Information.
  78.      Can have more than 1 General Information String
  79.      Total General Info is limited to 30,000 characters.
  80.      Example  =I=This cave is really very awesome.
  81.                     =I=It is so awesome, that we even mapped it.
  82.                     =I=Even so, we could only find 50 meters
  83.                     =I= of cave to map.
  84.  
  85. =C=   Precedes a Station Comment
  86.      The rest of the line is put into a Station Comment.
  87.      Comments are limited to 254 characters per station.
  88.      Example  =C=This station is directly over the pit!
  89.  
  90. =S1=   Precedes a New Section Name
  91. =S2=   ...(1,2,or3 is Sect Set#)
  92. =S3=   ...As Above...
  93.      The rest of the line is a Section Name.
  94.      If not already created, CavePlot adds this Section
  95.      Following stations will all belong to this Section
  96.      These commands work independantly of each other
  97.      Example  =S1=Surface
  98.      Example  =S2=Aug-94
  99.  
  100. =S$=   Specifies Section Num%, Status%, Color%, Name$
  101.      This command is used to specify info about a Section
  102.      To work properly, it should precede actual survey data
  103.      Example  =S$= 1  3  2  LeftHandMaze
  104.      This example names Section #1 "LeftHandMaze"
  105.      This example makes Section #1  Plot  Medium Blue
  106.      Status%:  2=Off, 3=Plot, 4=Bold, 5=Dim, Others -->Off
  107.      Color%:    0=White, 1=L-Blue, 2=M-Blue, 3=Green,
  108.           4=Yellow, 5=Red, 6=Magenta, 7=Black, 8=L-Gray
  109.           9=M-Gray, 10=L-Brown, 11=D-Brown, 12=D-Gray
  110.           13=D-Blue, 14=D-Green, 15=Orange, (16+ Repeats)
  111.  
  112. =SS=   Specifies Color and Status for Sections (obsolete)
  113.      This command is obsolete (superseded by =S$=)
  114.      See the =S$= command listed above
  115.  
  116. =O=   Precedes Data Ordering Information
  117.      This command is followed by a series of Strings
  118.      Data Order may be changed anywhere in the survey.
  119.      Data Order may be changed as often as desired.
  120.      Example  =D=DIST AZIM INCL LEFT RIGHT UP DOWN
  121.      Keywords may be either uppercase or lowercase
  122.      Recognized keywords currently include:
  123.           DIST   LENGTH
  124.           AZIM   AZIMUTH
  125.           INCL   VERTICAL
  126.           LEFT   RIGHT   UP   DOWN   CEILING   FLOOR
  127.  
  128. =D=   Precedes a Magnetic Declination Value
  129.      This numeric value is added to all following azimuths.
  130.      Declination may be changed anywhere in the survey.
  131.      Declination may be changed as often as desired.
  132.      Example  =D=14
  133.  
  134. =P=   Precedes a Pattern% (SICN) for following stations
  135.      The specified pattern applies to all following stations
  136.      Example  =P=1
  137.      The list of possible Patterns is long (1->50)
  138.      Patterns are best specified using 1-Point Stats
  139.      1-Point Stats is accessed by clicking on the lineplot
  140.  
  141. =A$=  Precedes an Attribute Char$, Flag$, Name$
  142.      This numeric value is added to all following azimuths.
  143.      Declination may be changed anywhere in the survey.
  144.      Declination may be changed as often as desired.
  145.      Example  =D=14
  146.  
  147. =A=   Precedes a Station's Attribute$
  148.      The text characters are each mapped to an Attribute
  149.      Attributes are added only to the the next station
  150.      Each station may have its own Attributes specified
  151.      Example  =A=ABFcdr
  152.      Station attributes are best specified within CavePlot
  153.      See the =A$= command for more information
  154.  
  155. =F=   Signals the end of the survey data
  156.      This command tells CavePlot to stop importing data
  157.      This command is optional, but useful.
  158.      It can be used to import only part of the survey data
  159.      It should be used when the file is longer than the data
  160.      Example  =F=
  161.  
  162.  
  163.